home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / gnu / emacs.lha / emacs-19.16 / src / frame.h < prev    next >
C/C++ Source or Header  |  1993-06-11  |  18KB  |  454 lines
  1. /* Define frame-object for GNU Emacs.
  2.    Copyright (C) 1993 Free Software Foundation, Inc.
  3.  
  4. This file is part of GNU Emacs.
  5.  
  6. GNU Emacs is free software; you can redistribute it and/or modify
  7. it under the terms of the GNU General Public License as published by
  8. the Free Software Foundation; either version 2, or (at your option)
  9. any later version.
  10.  
  11. GNU Emacs is distributed in the hope that it will be useful,
  12. but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. GNU General Public License for more details.
  15.  
  16. You should have received a copy of the GNU General Public License
  17. along with GNU Emacs; see the file COPYING.  If not, write to
  18. the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19.  
  20.  
  21. /* Miscellanea.  */
  22.  
  23. /* Nonzero means don't assume anything about current
  24.    contents of actual terminal frame */
  25. extern int frame_garbaged;
  26.  
  27. /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
  28.    print.  */
  29. extern int message_buf_print;
  30.  
  31.  
  32. /* The structure representing a frame.
  33.  
  34.    We declare this even if MULTI_FRAME is not defined, because when
  35.    we lack multi-frame support, we use one instance of this structure
  36.    to represent the one frame we support.  This is cleaner than
  37.    having miscellaneous random variables scattered about.  */
  38.  
  39. enum output_method
  40. { output_termcap, output_x_window };
  41.  
  42. struct frame
  43. {
  44.   int size;
  45.   struct Lisp_Vector *next;
  46.  
  47.   /* glyphs as they appear on the frame */
  48.   struct frame_glyphs *current_glyphs;
  49.  
  50.   /* glyphs we'd like to appear on the frame */
  51.   struct frame_glyphs *desired_glyphs;
  52.  
  53.   /* See do_line_insertion_deletion_costs for info on these arrays. */
  54.   /* Cost of inserting 1 line on this frame */
  55.   int *insert_line_cost;
  56.   /* Cost of deleting 1 line on this frame */
  57.   int *delete_line_cost;
  58.   /* Cost of inserting n lines on this frame */
  59.   int *insert_n_lines_cost;
  60.   /* Cost of deleting n lines on this frame */
  61.   int *delete_n_lines_cost;
  62.  
  63.   /* glyphs for the mode line */
  64.   struct frame_glyphs *temp_glyphs;
  65.  
  66.   /* Intended cursor position of this frame.
  67.      Measured in characters, counting from upper left corner
  68.      within the frame.  */
  69.   int cursor_x;
  70.   int cursor_y;
  71.  
  72.   /* Actual cursor position of this frame, and the character under it.
  73.      (Not used for terminal frames.)  */
  74.   int phys_cursor_x;
  75.   int phys_cursor_y;
  76.   /* This is handy for undrawing the cursor, because current_glyphs is
  77.      not always accurate when in do_scrolling.  */
  78.   GLYPH phys_cursor_glyph;
  79.  
  80.   /* Size of this frame, in units of characters.  */
  81.   int height;
  82.   int width;
  83.  
  84.   /* New height and width for pending size change.  0 if no change pending.  */
  85.   int new_height, new_width;
  86.  
  87.   /* Name of this frame: a Lisp string.  See also `explicit_name'.  */
  88.   Lisp_Object name;
  89.  
  90.   /* The frame which should receive keystrokes that occur in this
  91.      frame, or nil if they should go to the frame itself.  This is
  92.      usually nil, but if the frame is minibufferless, we can use this
  93.      to redirect keystrokes to a surrogate minibuffer frame when
  94.      needed.
  95.  
  96.      Note that a value of nil is different than having the field point
  97.      to the frame itself.  Whenever the Fselect_frame function is used
  98.      to shift from one frame to the other, any redirections to the
  99.      original frame are shifted to the newly selected frame; if
  100.      focus_frame is nil, Fselect_frame will leave it alone.  */
  101.   Lisp_Object focus_frame;
  102.  
  103.   /* This frame's root window.  Every frame has one.
  104.      If the frame has only a minibuffer window, this is it.
  105.      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
  106.   Lisp_Object root_window;
  107.  
  108.   /* This frame's selected window.
  109.      Each frame has its own window hierarchy
  110.      and one of the windows in it is selected within the frame.
  111.      The selected window of the selected frame is Emacs's selected window.  */
  112.   Lisp_Object selected_window;
  113.  
  114.   /* This frame's minibuffer window.
  115.      Most frames have their own minibuffer windows,
  116.      but only the selected frame's minibuffer window
  117.      can actually appear to exist.  */
  118.   Lisp_Object minibuffer_window;
  119.  
  120.   /* Parameter alist of this frame.
  121.      These are the parameters specified when creating the frame
  122.      or modified with modify-frame-parameters.  */
  123.   Lisp_Object param_alist;
  124.  
  125.   /* List of scroll bars on this frame.  
  126.      Actually, we don't specify exactly what is stored here at all; the
  127.      scroll bar implementation code can use it to store anything it likes.
  128.      This field is marked by the garbage collector.  It is here
  129.      instead of in the `display' structure so that the garbage
  130.      collector doesn't need to look inside the window-system-dependent
  131.      structure.  */
  132.   Lisp_Object scroll_bars;
  133.   Lisp_Object condemned_scroll_bars;
  134.  
  135.   /* List of elements to display in the menu bar.
  136.      The elements have the form (KEY STRING . nil) to start;
  137.      when they are displayed, the hpos of the left edge goes in the cddr.  */
  138.   Lisp_Object menu_bar_items;
  139.  
  140.   /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA).  */
  141.   Lisp_Object face_alist;
  142.  
  143.   /* The output method says how the contents of this frame
  144.      are displayed.  It could be using termcap, or using an X window.  */
  145.   enum output_method output_method;
  146.  
  147.   /* A structure of auxiliary data used for displaying the contents.
  148.      struct x_display is used for X window frames;
  149.      it is defined in xterm.h.  */
  150.   union display { struct x_display *x; int nothing; } display;
  151.  
  152.   /* Number of lines of menu bar.  */
  153.   int menu_bar_lines;
  154.  
  155.   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
  156.   char display_preempted;
  157.  
  158.   /* visible is nonzero if the frame is currently displayed; we check
  159.      it to see if we should bother updating the frame's contents.
  160.      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
  161.  
  162.      Note that, since invisible frames aren't updated, whenever a
  163.      frame becomes visible again, it must be marked as garbaged.  The
  164.      FRAME_SAMPLE_VISIBILITY macro takes care of this.
  165.  
  166.      iconified is nonzero if the frame is currently iconified.
  167.  
  168.      Asynchronous input handlers should NOT change these directly;
  169.      instead, they should change async_visible or async_iconified, and
  170.      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
  171.      at the next redisplay.
  172.  
  173.      These should probably be considered read-only by everyone except
  174.      FRAME_SAMPLE_VISIBILITY.
  175.  
  176.      This two are mutually exclusive.  They might both be zero, if the
  177.      frame has been made invisible without an icon.  */
  178.   char visible, iconified;
  179.  
  180.   /* Asynchronous input handlers change these, and
  181.      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
  182.      See FRAME_SAMPLE_VISIBILITY, below.  */
  183. #ifdef __STDC__
  184.   volatile
  185. #endif
  186.   char async_visible, async_iconified;
  187.  
  188.   /* Nonzero if this frame should be redrawn.  */
  189. #ifdef __STDC__
  190.   volatile
  191. #endif
  192.   char garbaged;
  193.  
  194.   /* True if frame actually has a minibuffer window on it.
  195.      0 if using a minibuffer window that isn't on this frame.  */
  196.   char has_minibuffer;
  197.      
  198.   /* 0 means, if this frame has just one window,
  199.      show no modeline for that window.  */
  200.   char wants_modeline;
  201.  
  202.   /* Non-zero if the hardware device this frame is displaying on can
  203.      support scroll bars.  */
  204.   char can_have_scroll_bars;
  205.  
  206.   /* If can_have_scroll_bars is non-zero, this is non-zero if we should
  207.      actually display them on this frame.  */
  208.   char has_vertical_scroll_bars;
  209.  
  210.   /* Non-0 means raise this frame to the top of the heap when selected.  */
  211.   char auto_raise;
  212.  
  213.   /* Non-0 means lower this frame to the bottom of the stack when left.  */
  214.   char auto_lower;
  215.  
  216.   /* True if frame's root window can't be split.  */
  217.   char no_split;
  218.  
  219.   /* If this is set, then Emacs won't change the frame name to indicate
  220.      the current buffer, etcetera.  If the user explicitly sets the frame
  221.      name, this gets set.  If the user sets the name to Qnil, this is
  222.      cleared.  */
  223.   char explicit_name;
  224.  
  225.   /* Storage for messages to this frame. */
  226.   char *message_buf;
  227.  
  228.   /* Nonnegative if current redisplay should not do scroll computation
  229.      for lines beyond a certain vpos.  This is the vpos.  */
  230.   int scroll_bottom_vpos;
  231. };
  232.  
  233. #ifdef MULTI_FRAME
  234.  
  235. typedef struct frame *FRAME_PTR;
  236.  
  237. #define XFRAME(p) ((struct frame *) XPNTR (p))
  238. #define XSETFRAME(p, v) ((struct frame *) XSETPNTR (p, v))
  239.  
  240. #define WINDOW_FRAME(w) (w)->frame
  241.  
  242. #define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
  243. #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
  244. #define FRAME_X_P(f) ((f)->output_method == output_x_window)
  245. #define FRAME_MINIBUF_ONLY_P(f) \
  246.   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
  247. #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
  248. #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
  249. #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
  250. #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
  251. #define FRAME_HEIGHT(f) (f)->height
  252. #define FRAME_WIDTH(f) (f)->width
  253. #define FRAME_NEW_HEIGHT(f) (f)->new_height
  254. #define FRAME_NEW_WIDTH(f) (f)->new_width
  255. #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
  256. #define FRAME_CURSOR_X(f) (f)->cursor_x
  257. #define FRAME_CURSOR_Y(f) (f)->cursor_y
  258. #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
  259. #define FRAME_SET_VISIBLE(f,p) \
  260.   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
  261. #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
  262. #define FRAME_GARBAGED_P(f) (f)->garbaged
  263. #define FRAME_NO_SPLIT_P(f) (f)->no_split
  264. #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
  265. #define FRAME_ICONIFIED_P(f) (f)->iconified
  266. #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
  267. #define FRAME_ROOT_WINDOW(f) (f)->root_window
  268. #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
  269. #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
  270. #define FRAME_INSERT_COST(f) (f)->insert_line_cost    
  271. #define FRAME_DELETE_COST(f) (f)->delete_line_cost    
  272. #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
  273. #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
  274. #define FRAME_MESSAGE_BUF(f) (f)->message_buf
  275. #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
  276. #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
  277. #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
  278. #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars)
  279. #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
  280. #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
  281. #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
  282.  
  283. /* Emacs's redisplay code could become confused if a frame's
  284.    visibility changes at arbitrary times.  For example, if a frame is
  285.    visible while the desired glyphs are being built, but becomes
  286.    invisible before they are updated, then some rows of the
  287.    desired_glyphs will be left marked as enabled after redisplay is
  288.    complete, which should never happen.  The next time the frame
  289.    becomes visible, redisplay will probably barf.
  290.  
  291.    Currently, there are no similar situations involving iconified, but
  292.    the principle is the same.
  293.  
  294.    So instead of having asynchronous input handlers directly set and
  295.    clear the frame's visibility and iconification flags, they just set
  296.    the async_visible and async_iconified flags; the redisplay code
  297.    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
  298.    which sets visible and iconified from their asynchronous
  299.    counterparts.
  300.  
  301.    Synchronous code must use the FRAME_SET_VISIBLE macro.
  302.  
  303.    Also, if a frame used to be invisible, but has just become visible,
  304.    it must be marked as garbaged, since redisplay hasn't been keeping
  305.    up its contents.  */
  306. #define FRAME_SAMPLE_VISIBILITY(f) \
  307.   (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
  308.    (f)->visible = (f)->async_visible, \
  309.    (f)->iconified = (f)->async_iconified)
  310.  
  311. #define CHECK_FRAME(x, i)                \
  312.   {                            \
  313.     if (! FRAMEP (x))                    \
  314.       x = wrong_type_argument (Qframep, (x));        \
  315.   }
  316.  
  317. #define CHECK_LIVE_FRAME(x, i)                \
  318.   {                            \
  319.     if (! FRAMEP (x)                    \
  320.     || ! FRAME_LIVE_P (XFRAME (x)))        \
  321.       x = wrong_type_argument (Qframe_live_p, (x));    \
  322.   }
  323.  
  324. /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
  325.    `for' loop which iterates over the elements of Vframe_list.  The
  326.    loop will set FRAME_VAR, a Lisp_Object, to each frame in
  327.    Vframe_list in succession and execute the statement.  LIST_VAR
  328.    should be a Lisp_Object too; it is used to iterate through the
  329.    Vframe_list.  
  330.  
  331.    If MULTI_FRAME isn't defined, then this loop expands to something which 
  332.    executes the statement once.  */
  333. #define FOR_EACH_FRAME(list_var, frame_var)            \
  334.   for ((list_var) = Vframe_list;                \
  335.        (CONSP (list_var)                    \
  336.     && (frame_var = XCONS (list_var)->car, 1));        \
  337.        list_var = XCONS (list_var)->cdr)
  338.  
  339.  
  340. extern Lisp_Object Qframep, Qframe_live_p, Qicon;
  341.  
  342. extern struct frame *selected_frame;
  343. extern struct frame *last_nonminibuf_frame;
  344.  
  345. extern struct frame *make_terminal_frame ();
  346. extern struct frame *make_frame ();
  347. extern struct frame *make_minibuffer_frame ();
  348. extern struct frame *make_frame_without_minibuffer ();
  349.  
  350. extern Lisp_Object Vframe_list;
  351. extern Lisp_Object Vdefault_frame_alist;
  352.  
  353. extern Lisp_Object Vterminal_frame;
  354.  
  355. #else /* not MULTI_FRAME */
  356.  
  357. /* These definitions are used in a single-frame version of Emacs.  */
  358.  
  359. #define FRAME_PTR int
  360.  
  361. /* A frame we use to store all the data concerning the screen when we
  362.    don't have multiple frames.  Remember, if you store any data in it
  363.    which needs to be protected from GC, you should staticpro that
  364.    element explicitly.  */
  365. extern struct frame the_only_frame;
  366.  
  367. extern int selected_frame;
  368. extern int last_nonminibuf_frame;
  369.  
  370. #define XFRAME(f) selected_frame
  371. #define WINDOW_FRAME(w) selected_frame
  372.  
  373. #define FRAME_LIVE_P(f) 1
  374. #define FRAME_TERMCAP_P(f) 1
  375. #define FRAME_X_P(f) 0
  376. #define FRAME_MINIBUF_ONLY_P(f) 0
  377. #define FRAME_HAS_MINIBUF_P(f) 1
  378. #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
  379. #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
  380. #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
  381. #define FRAME_HEIGHT(f) (the_only_frame.height)
  382. #define FRAME_WIDTH(f) (the_only_frame.width)
  383. #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
  384. #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
  385. #define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines)
  386. #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
  387. #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
  388. #define FRAME_SET_VISIBLE(f,p) (p)
  389. #define FRAME_VISIBLE_P(f) 1
  390. #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
  391. #define FRAME_GARBAGED_P(f) (frame_garbaged)
  392. #define FRAME_NO_SPLIT_P(f) 0
  393. #define FRAME_WANTS_MODELINE_P(f) 1
  394. #define FRAME_ICONIFIED_P(f) 0
  395. #define FRAME_MINIBUF_WINDOW(f) (minibuf_window)
  396. #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
  397. #define FRAME_SELECTED_WINDOW(f) (selected_window)
  398. #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
  399. #define FRAME_INSERT_COST(frame)  (the_only_frame.insert_line_cost)
  400. #define FRAME_DELETE_COST(frame)  (the_only_frame.delete_line_cost)
  401. #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
  402. #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
  403. #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
  404. #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
  405. #define FRAME_FOCUS_FRAME(f) (Qnil)
  406. #define FRAME_CAN_HAVE_SCROLL_BARS(f) (the_only_frame.can_have_scroll_bars)
  407. #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
  408.   (the_only_frame.has_vertical_scroll_bars)
  409. #define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars)
  410. #define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars)
  411. #define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items)
  412.  
  413. /* See comments in definition above.  */
  414. #define FRAME_SAMPLE_VISIBILITY(f) (0)
  415.  
  416. #define CHECK_FRAME(x, i) do; while (0)
  417. #define CHECK_LIVE_FRAME(x, y) do; while (0)
  418.  
  419. /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
  420.    `for' loop which iterates over the elements of Vframe_list.  The
  421.    loop will set FRAME_VAR, a Lisp_Object, to each frame in
  422.    Vframe_list in succession and execute the statement.  LIST_VAR
  423.    should be a Lisp_Object too; it is used to iterate through the
  424.    Vframe_list.  
  425.  
  426.    If MULTI_FRAME _is_ defined, then this loop expands to a real
  427.    `for' loop which traverses Vframe_list using LIST_VAR and
  428.    FRAME_VAR.  */
  429. #define FOR_EACH_FRAME(list_var, frame_var)            \
  430.   for (list_var = Qt; frame_var = selected_frame, ! NILP (list_var); list_var = Qnil)
  431.  
  432. #endif /* not MULTI_FRAME */
  433.  
  434.  
  435. /* Device- and MULTI_FRAME-independent scroll bar stuff.  */
  436.  
  437. /* The number of columns a vertical scroll bar occupies.  */
  438. #define VERTICAL_SCROLL_BAR_WIDTH (2)
  439.  
  440. /* Return the starting column (zero-based) of the vertical scroll bar
  441.    for window W.  The column before this one is the last column we can
  442.    use for text.  If the window touches the right edge of the frame,
  443.    we have extra space allocated for it.  Otherwise, the scroll bar
  444.    takes over the window's rightmost columns.  */
  445. #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
  446.   (((XINT ((w)->left) + XINT ((w)->width)) \
  447.     < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
  448.    ? XINT ((w)->left) + XINT ((w)->width) - VERTICAL_SCROLL_BAR_WIDTH \
  449.    : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))
  450.  
  451. /* Return the height in lines of the vertical scroll bar in w.  If the
  452.    window has a mode line, don't make the scroll bar extend that far.  */
  453. #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))
  454.